Delete Customer External Params Config
Delete Customer External Params Config API is used to delete one or more External Parameters Configuration items of a specific Entity Type (Customer, Subscriber, or Offer or Package). Deletion is done as a soft deletion procedure. When sending a request to delete multiple External Parameters Configuration items in a single call, the result will treat them all hence it is either all External Parameters Configuration items deletion were succeeded, or all resulted with a failure.
NOTE: Delete External Params Config item, also deletes all his connected instances. Sending External Parameters Configuration item IDs for deletion, both as part of the URL and in the request itself will result in a “bad request” notification.
| HTTP URL |
|
|---|---|
| DELETE | /api/v2/customer/{id}/external-params-config/{id} |
The second {id} is the requested External Parameter Configuration item UUID.
Eligibility
The Requester is eligible to delete a single or multiple External Parameters Configuration items of its own customer entities (sub-customers, its own subscribers, Sell packages and Sell plans). The Requester is not eligible delete existing External Parameters Configuration items at any other customer level, including its own sub-customers’ entities.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
id |
UUID |
O |
Array of External Parameters Configuration item IDs to be deleted |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
content |
Object |
O |
Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
requestId |
UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed |
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
CUSTOMER_1002 |
Customer does not exist |
|
CUSTOMER_1022 |
Failed to delete external params config item |
|
GLOBAL_1001 |
Service unavailable. Please try again |
Examples
Request Body
{
"id": [
"e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
"ceb892d2-f24b-4007-bf81-999fe75cb635"
]
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
{
"errorCode": "CUSTOMER_1002",
"errorMessage": "Customer does not exist",
"content": "",
"pageable": ""
}